package lumis.portal.audit;

import lumis.portal.PortalException;

/**
 * Interface of Audit manager.
 *
 * @version $Revision: 13093 $ $Date: 2011-05-28 18:40:18 -0300 (Sat, 28 May 2011) $
 * @since 6.0.0
 */
public interface IAuditManager
{
	static final String QUERY_CACHE_REGION = "lumis.portal.audit.IAuditManager#query";
	
	/**
	 * Register an audit entry.
	 * @param title				the operation title. If the title is bigger
	 * 							than the allowed size, the string is truncated. 
	 * @param description		the operation description.
	 * @param typeKey			the AuditEntryType key.
	 * @throws PortalException	if an error occur during audit.
	 * @since 6.0.0
	 */
	public void audit(String title,
									String description,
									String typeKey)
								throws PortalException;
}